Rewrite outdated docs, bump to 8.4#1258
Merged
droserasprout merged 17 commits intonextfrom May 19, 2025
Merged
Conversation
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR updates various documentation files to reflect the new DipDup version 8.4.0 and revises several guides and changelogs to remove outdated instructions.
- Update version numbers in configuration and changelog files.
- Rewrite and reformat documentation sections (e.g. configuration merging, Docker, FAQ) for clarity and consistency.
- Remove outdated backup examples from the docs.
Reviewed Changes
Copilot reviewed 313 out of 313 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| src/demo_blank/.dockerignore | Updated header comment to reflect version 8.4.0. |
| pyproject.toml | Bumped project version from 8.3.4 to 8.4.0. |
| docs/9.release-notes/_8.4_changelog.md | Added changelog entries for release 8.4.0. |
| docs/9.release-notes/_8.3_changelog.md | Updated changelog by removing outdated entries. |
| docs/8.examples/_demos_table.md | Updated demo project URLs to version 8.4.0. |
| docs/5.advanced/6.sqd-cloud.md | Added a warning banner and updated commands for cloud deployment. |
| docs/5.advanced/5.backups.md | Removed legacy backup and restore documentation. |
| docs/5.advanced/2.environment-variables.md | Revised instructions and corrected typos. |
| docs/5.advanced/1.docker.md | Updated Docker instructions and command examples. |
| docs/15.glossary.md | Refined glossary terms and definitions. |
| docs/14.contributing.md | Revised contributing guidelines and development commands. |
| docs/12.faq.md | Updated FAQ answers with clearer instructions. |
| docs/10.supported-networks/0.overview.md | Added instruction to generate an env file using a CLI command. |
| docs/1.getting-started/6.models.md | Streamlined models documentation and updated terminology. |
| docs/1.getting-started/5.database.md | Added a warning banner regarding migration practices. |
| docs/1.getting-started/4.package.md | Updated project structure and package merging details. |
| docs/1.getting-started/3.config.md | Revised config merging instructions and environment variable usage. |
| docs/1.getting-started/1.installation.md | Updated Docker installation instructions and details. |
| Makefile | Removed outdated schema export commands. |
| CHANGELOG.md | Updated version tags and reference links to 8.4.0. |
Wizard1209
approved these changes
May 19, 2025
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
No description provided.